home *** CD-ROM | disk | FTP | other *** search
/ CD ROM Paradise Collection 4 / CD ROM Paradise Collection 4 1995 Nov.iso / os2 / dmplay92.zip / DMPlayer.doc next >
Text File  |  1994-01-23  |  15KB  |  309 lines
  1.  
  2.                              Digital Music Player
  3.                                  version 0.91
  4.  
  5.                               an Aria production
  6.  
  7.  
  8. 0. Documentation
  9. ----------------
  10.    This documentation is a temporary solution.  As of version 0.9, there is no
  11. online help available.  Version 1.0 will include a full help system.  The 
  12. reason for the lack of help in this version is the fact that I want to satisfy 
  13. the demand for a quality .MOD music module player.  
  14.  
  15. 1. Introduction
  16. ---------------
  17.    Digital Music Player is a multi-threaded .MOD (see section 3. for info)
  18. format music module player for OS/2 2.x with the MMPM/2 multimedia extensions 
  19. installed.  A digital capable audio adapter is required.  DMPlayer has been 
  20. designed to work well with you.  It is capable of playing songs in the 
  21. background while you get real work done with a minimum of interruption.  Aside 
  22. from the wonderful music of course.  You will be able to listen to your 
  23. favorite modules and still have a responsive system at your fingertips.  
  24. DMPlayer even cooperates with the system sounds provided by MMPM/2.  
  25.  
  26.    Digital Music Player is currently capable of playing the following formats:
  27.  
  28.       4 track, 31 and 15 instrument Protracker/Noisetracker modules
  29.       4 and 8 track Startrekker modules
  30.       6 and 8 track Fasttracker modules
  31.  
  32.    More formats will be supported in the future.
  33.  
  34. 1.2. Ariaware
  35. -------------
  36.    This software product is provided to you for the sole purpose of evaluation
  37. to purchase.  DMPlayer is not free.  You are granted license to a trial 
  38. evaluation period of 30 days in which to determine if you wish to continue 
  39. using the program.  If you decide to use DMPlayer after the 30 day trial 
  40. period, you must pay the registration fee of $20 (US).  Any use beyond the 30 
  41. day trial period is prohibited by law.  Please see the file REGISTER.TXT for 
  42. more information on how to register.  
  43.  
  44. 1.2.1. Limitations
  45. ------------------
  46.    If you have not registered DMPlayer, then you will have to face up to a few
  47. limitations.  These limitations are critical, however, they do not interfere 
  48. with the evaluation of the program.  
  49.  
  50.    The current limitations are as follows:
  51.  
  52.    1.    Inability to save settings between sessions.  Normally, DMPlayer would
  53.          remember window positions, audio settings, playback settings and 
  54.          directories accessed.
  55.  
  56.    2.    Inability to load or save SongLists.  All other aspects of the 
  57.          SongList window are fully functional.
  58.  
  59.    I hope that you do not find that these limitations are too restrictive.  You
  60. should still be able to determine whether or not you wish to use the program 
  61. even with these restrictions.  
  62.  
  63.    Due to these limitations, many people may quickly dub this software as
  64. 'Crippleware' or the like.  Be that as it may, I have made a serious investment 
  65. in the development of DMPlayer and I must protect that investment.  I have 
  66. tried to do so in the most benign manner possible.  
  67.  
  68. 1.2.2. Registration
  69. -------------------
  70.    When you register DMPlayer, you will receive a keyfile unlocking the full 
  71. functionality of the program.  The one time registration fee will provide you 
  72. with *free upgrades for the life of this program*.  Both minor and major 
  73. upgrades will be made available via your favorite OS/2 shareware distribution 
  74. site.  All future versions of this program will automatically be unlocked by 
  75. the keyfile you will receive.  Please see the file REGISTER.TXT for more 
  76. information on how to register.  
  77.  
  78. 1.2.3. Support
  79. --------------
  80.    DMPlayer is an evolving product.  Support for other module formats will
  81. become available in the future.  More functionality may be added at some later 
  82. date.  All of which is free to registered users.  Support is made available via 
  83. the internet.  Mail questions and/or comments to:  
  84.  
  85.          dodger@kira.csos.orst.edu
  86. or       murrayk@instruction.cs.orst.edu
  87.  
  88. 1.3. Distribution
  89. -----------------
  90.    Digital Music Player may be freely distributed provided that the entire 
  91. archive remains intact.  Shareware distributors may not charge more than $5 
  92. (including shipping) for this software package.
  93.  
  94. 1.4. Warranty
  95. -------------
  96.    No warranty of any kind is implicitly or explicitly granted through use of
  97. this program.  Aria will not be held liable for any damages resulting form the 
  98. use of this product.  
  99.  
  100. 1.5. Installation
  101. -----------------
  102.    Digital Music Player needs no special setup.  Simply copy the program file
  103. into a directory and create a program object if you desire.  DMPlayer can be 
  104. placed anywhere.  It will search for, or create any files that it needs in the 
  105. directory where the executable is.  This will allow DMPlayer to be run from the
  106. command line without cluttering your file system with DMPlayer.INI files.
  107.  
  108. 1.6. Running DMPlayer
  109. ---------------------
  110.    DMPlayer will accept .MOD files from the command line.  DMPlayer understands
  111. the standard OS/2 wildcard system for selecting files.  You can specify as many
  112. files as you like on the command line.  DMPlayer will create a new songlist 
  113. containing all the files specified on the command line.
  114.  
  115. 2. Explanation
  116. --------------
  117.    The heart of Digital Music Player is the main control panel.  This dialog 
  118. box presents the most amount of information in the least amount of space 
  119. possible.  It will not hog your entire desktop.  It has been designed to 
  120. somewhat resemble an CD player so the funcitonality should be readily apparent.  
  121.  
  122. 2.1. Main Dialog
  123. ----------------
  124.    This is the basic layout of the main dialog.
  125.  
  126.    +-------------------------------------------------------------------------+
  127.    |[ ] Digital Music Player                                              [o]|
  128.    +---------------------------------------------------+---------------------+
  129.    | SongList name                       track x of y  | SongList |   Audio  |
  130.    |                                                   |  dialog  |  Control |
  131.    | Current module name                        time   +----------+----------+
  132.    +---------------------------------------------------+  Module  | Playback |
  133.    | Play | Pause | Stop | Rew | FF |    | Prev | Next |   Info   | Settings |
  134.    +---------------------------------------------------+---------------------+
  135.  
  136.    The display is easy to understand.  The current SongList is displayed in the
  137. upper left corner.  This is also where you will be notified of problems 
  138. relating to the SongList.  The current module is displayed in the lower left 
  139. corner of the display.  Status messages related to the current module are 
  140. displayed here.  The current and total tracks display is located in the upper 
  141. right corner of the display.  The elapsed time is displayed in the lower right 
  142. corner.  The time display does not take into account skipping about in the 
  143. song.  It simply displays a running elapsed time that the song has been 
  144. playing.  
  145.  
  146.    If you have ever used a CD player, then you should be able to control the
  147. playback of your music modules with DMPlayer.  All the buttons act as they 
  148. would on any CD player.  The 'Prev' and 'Next' buttons select the previous or 
  149. next song in the SongList.  
  150.  
  151.    The four buttons on the far right of the main dialog control the appearance
  152. of the four auxiliary dialogs.  They act as toggles, showing the relative 
  153. dialog if it is hidden, and hiding it if visible.  
  154.  
  155.    There are also two menu items added to the system menu. The 'About...' 
  156. option displays the copyright, version information, and who the program is 
  157. registered to. The 'Help' menu item will open the help system in the future.
  158.  
  159. 2.2. Playback Settings
  160. ----------------------
  161.    This is the dialog where you determine the output quality.  DMPlayer 
  162. supports either 8 or 16 bits per sample in both mono and stereo modes.  If your 
  163. audio adapter does not support stereo or 16 bit, then those options will be 
  164. disabled.  You also set the frequency for playback here.  The frequency slider 
  165. allows you to make a precise tradeoff between processor time and quality.  The 
  166. lower the setting, the less time DMPlayer will steal from the system.  The 
  167. higher the frequency, the better the output quality.  The differences, in terms 
  168. of processor time, between 8 and 16 bit or stereo and mono are negligible in 
  169. most situations.  These settings do not take effect while a song is playing.  
  170. It must be stopped and then restarted for them to become apparent.  
  171.  
  172. 2.3. Audio Control
  173. ------------------
  174.    This is where you can adjust the volume, balance, bass and treble.  Not all
  175. audio adapters support these settings.  However, due to a limitation in the 
  176. MMPM/2 interface, there is no way to determine certain hardware capabilities so 
  177. all of these controls are enabled whether or not your particular audio adapter 
  178. supports the action.  
  179.  
  180. 2.4. Module Information
  181. -----------------------
  182.    This dialog displays some detaild information about the current module. 
  183. This includes the name, number of channels, format, full path name and a list 
  184. of the samples in the module.  The list of samples shows the sample name, 
  185. length, repeat offset and the repeat length.  
  186.  
  187. 2.5. SongList
  188. -------------
  189.    A SongList is a collection of music modules that can be loaded, edited and 
  190. saved.  Clicking on the SongList window with the context mouse button (by 
  191. default the right mouse button) brings up the context menu for the SongList.  
  192. The SongList supports 6 different views of its contents:  Icon, Name, Name 
  193. Flowed, Text, Text Flowed, and Details.  These views are the same as their 
  194. respective views in the WPS folder system.  This should be a very familiar 
  195. system to work with.  That was the whole purpose in designing the SongList in 
  196. this manner.  Drag and drop operations are also supported.  You can drag songs 
  197. within the SongList to reorder.  You can also drag music modules from the file 
  198. system and drop them in the SongList!  Experimentation is the direct way to 
  199. understanding.  To play a song, simply double-click on it and listen and enjoy!
  200.  
  201. 2.5.1. SongList Menus
  202. ---------------------
  203.    The SongList menu has the following options:
  204.  
  205.    New:        Start a new SongList from scratch.
  206.    Open:       Open a SongList that was previously saved.
  207.    Save:       Save the current SongList.
  208.    Save as:    Save the current SongList with a different name.
  209.  
  210.    Add songs:  Select songs to insert into the SongList.
  211.  
  212.    View:
  213.       Icon:    Select the Icon view.
  214.       Name:    Select the Name view.
  215.       Text:    Select the Text view.
  216.       Details: Select the Details view.
  217.       Flowed:  Select whether or not to flow the Name or Text view.
  218.  
  219.    Select:
  220.       Select all:    Select all items in the SongList.
  221.       Deselect all:  Deselect all items in the SongList.
  222.  
  223.    The context menu for one entry has the following options:
  224.  
  225.    Play:       Start playing this song.
  226.    Remove:     Remove this song from the SongList.
  227.    Delete:     Delete this song file from the disk.
  228.  
  229.    The context menu for several selected entries has the following options:
  230.  
  231.    Remove:     Remove these selected songs from the SongList.
  232.    Delete:     Delete these song files from the disk.
  233.  
  234. 2.5.2. Reordering the SongList
  235. ------------------------------
  236.    Reordering of the SongList is easy.  Simply drag the item to be repositioned
  237. to it's destination and release the button.  In the Icon view, there is no real 
  238. concept of 'between' items, so attempting to drop an item between two others 
  239. will result in that item moving to the end of the list.  In all other views, 
  240. items may be placed between (or before or after) others.  Items may also be 
  241. placed 'before' another item by dropping onto the destination.  Experiment and 
  242. you will understand.  
  243.  
  244. 3. What is a .MOD file and where can I get them?
  245. ------------------------------------------------
  246.    A .MOD file is a digital song file.  The format was developed on the Amiga 
  247. to take advantage of that machines 4 DACs (Digital to Analog Converters).  The 
  248. file contains blocks of commands for each track.  Each command tells what 
  249. instrument to play and at what note to play it.  Special effects are also 
  250. specified by the commands.  The instruments are stored as samples at the end of 
  251. the track information.  Hence the rather large size of .MOD files.  
  252.    The format originally consisted of only 4 tracks and 15 instruments.  It has
  253. since evolved to anywhere from 4 to 8 tracks and 31 instruments.  A 'standard' 
  254. .MOD file now has 4 tracks and 31 instruments.  Some trackers produce 6 and 8 
  255. track .MOD files with 31 instruments.  
  256.  
  257.    One of the best places to find .MOD files is at an Aminet site.  There is an
  258. Aminet site on ftp.cdrom.com.  Look in the pub/aminet/mods/misc and the
  259. pub/aminet/mods/pro directories for .MOD files that DMPlayer can handle.
  260.  
  261. 4. Hardware Issues
  262. ------------------
  263.    One might think that the advent of MMPM/2 introduces the age of pure 
  264. hardware independence.  While MMPM/2 goes a LONG way in doing that, there will 
  265. still be problems rising from the fact that SOMEONE has to write device drivers
  266. for each audio adapter out there.  And while these drivers do exist, there 
  267. remains a lot to be desired.  So, while DMPlayer SHOULD work just fine with any
  268. MMPM/2 supported audio adapter, there may still be some things to look out for.
  269.  
  270. 4.1. Pro Audio Spectrum 16
  271. --------------------------
  272.    In order to listen to 16 bit audio, you must set the DMA channel 5 or above.
  273. All lower channels only support 8 bit DMA.
  274.  
  275. 4.2. Soundblaster family
  276. ------------------------
  277.    There don't seem to be any specific problems with this card, but there have 
  278. been many reports of seeming 'random' crashes that are impossible to track 
  279. down.  My only hope is that Creative Labs will better support these cards in 
  280. the future.
  281.  
  282. 5. Thanks
  283. ---------
  284.    Thanks go out to the following people for doing some *serious* late night 
  285. bug hunting:
  286.  
  287.    Adrian Idzik
  288.    Linden deCarmo
  289.    Dave Killian
  290.    Chance Geurin
  291.  
  292.    Special thanks to Linden deCarmo for all his support and answered questions 
  293. about the innermost workings of MMPM/2.  You guys did a great job with MMPM/2 
  294. Linden!  Thanks for all the help and answered questions and bug reports and 
  295. moral support and etc...  8^) 
  296.  
  297.    Thanks to my other early beta testers. You all helped out!
  298.  
  299.    Thanks also goes out to Kathleen Panov, Larry Salomon (aka Q) and Arthur 
  300. Panov for their work on the wonderful 'The Art of OS/2 2.1 C Programming'. It 
  301. is an absolutely GREAT book and a MUST-HAVE for any OS/2 programmer.
  302.  
  303. -1/17/94-
  304.  
  305. +----------------------------------------------------------------------------+
  306. |    Digital Music Player was coded by Keith Murray (the Dodger) of Aria.    |
  307. |             Copyright (c) 1993-1994 Aria, all rights reserved.             |
  308. +----------------------------------------------------------------------------+
  309.